<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SMTC Modem API: smtc_basic_modem_lr1110_api_extension.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SMTC Modem API
   </div>
   <div id="projectbrief">Generic Modem API description</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">smtc_basic_modem_lr1110_api_extension.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Modem API extension for Basic Modem with lr1110 radio.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;stdbool.h&gt;</code><br />
<code>#include &quot;<a class="el" href="smtc__modem__api_8h_source.html">smtc_modem_api.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for smtc_basic_modem_lr1110_api_extension.h:</div>
<div class="dyncontent">
<div class="center"><img src="smtc__basic__modem__lr1110__api__extension_8h__incl.png" border="0" usemap="#asmtc__basic__modem__lr1110__api__extension_8h" alt=""/></div>
<map name="asmtc__basic__modem__lr1110__api__extension_8h" id="asmtc__basic__modem__lr1110__api__extension_8h">
<area shape="rect" title="Modem API extension for Basic Modem with lr1110 radio." alt="" coords="5,5,205,47"/>
<area shape="rect" title=" " alt="" coords="17,169,87,196"/>
<area shape="rect" title=" " alt="" coords="117,169,200,196"/>
<area shape="rect" href="smtc__modem__api_8h.html" title="Generic Modem API description." alt="" coords="30,95,181,121"/>
</map>
</div>
</div>
<p><a href="smtc__basic__modem__lr1110__api__extension_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:afec76191fcede082555f72aa79423613"><td class="memItemLeft" align="right" valign="top"><a id="afec76191fcede082555f72aa79423613"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="smtc__basic__modem__lr1110__api__extension_8h.html#afec76191fcede082555f72aa79423613">SMTC_MODEM_PIN_LENGTH</a>&#160;&#160;&#160;4</td></tr>
<tr class="memdesc:afec76191fcede082555f72aa79423613"><td class="mdescLeft">&#160;</td><td class="mdescRight">Modem pin code length in byte. <br /></td></tr>
<tr class="separator:afec76191fcede082555f72aa79423613"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8e647ada35b4b3d754f2eb80f29f2305"><td class="memItemLeft" align="right" valign="top"><a class="el" href="smtc__modem__api_8h.html#a952d295e178005c052f035b4099ada4a">smtc_modem_return_code_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="smtc__basic__modem__lr1110__api__extension_8h.html#a8e647ada35b4b3d754f2eb80f29f2305">smtc_modem_get_pin</a> (uint8_t stack_id, uint8_t chip_pin[<a class="el" href="smtc__basic__modem__lr1110__api__extension_8h.html#afec76191fcede082555f72aa79423613">SMTC_MODEM_PIN_LENGTH</a>])</td></tr>
<tr class="memdesc:a8e647ada35b4b3d754f2eb80f29f2305"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the modem pin code if applicable.  <a href="smtc__basic__modem__lr1110__api__extension_8h.html#a8e647ada35b4b3d754f2eb80f29f2305">More...</a><br /></td></tr>
<tr class="separator:a8e647ada35b4b3d754f2eb80f29f2305"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb18f0cba3713bd58ffbe5c80a3f45d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="smtc__modem__api_8h.html#a952d295e178005c052f035b4099ada4a">smtc_modem_return_code_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="smtc__basic__modem__lr1110__api__extension_8h.html#adb18f0cba3713bd58ffbe5c80a3f45d9">smtc_modem_get_chip_eui</a> (uint8_t stack_id, uint8_t chip_eui[<a class="el" href="smtc__modem__api_8h.html#ad5683363bec8bb86c2993e18909fe50d">SMTC_MODEM_EUI_LENGTH</a>])</td></tr>
<tr class="memdesc:adb18f0cba3713bd58ffbe5c80a3f45d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the modem chip eui if applicable.  <a href="smtc__basic__modem__lr1110__api__extension_8h.html#adb18f0cba3713bd58ffbe5c80a3f45d9">More...</a><br /></td></tr>
<tr class="separator:adb18f0cba3713bd58ffbe5c80a3f45d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a961d1b3ad7ded3bd23ead28508bd336d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="smtc__modem__api_8h.html#a952d295e178005c052f035b4099ada4a">smtc_modem_return_code_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="smtc__basic__modem__lr1110__api__extension_8h.html#a961d1b3ad7ded3bd23ead28508bd336d">smtc_modem_derive_keys</a> (uint8_t stack_id)</td></tr>
<tr class="memdesc:a961d1b3ad7ded3bd23ead28508bd336d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Derive keys if applicable.  <a href="smtc__basic__modem__lr1110__api__extension_8h.html#a961d1b3ad7ded3bd23ead28508bd336d">More...</a><br /></td></tr>
<tr class="separator:a961d1b3ad7ded3bd23ead28508bd336d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Modem API extension for Basic Modem with lr1110 radio. </p>
<p>Revised BSD License Copyright Semtech Corporation 2020. All rights reserved.</p>
<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p><ul>
<li>Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.</li>
<li>Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.</li>
<li>Neither the name of the Semtech corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.</li>
</ul>
<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SEMTECH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a961d1b3ad7ded3bd23ead28508bd336d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a961d1b3ad7ded3bd23ead28508bd336d">&#9670;&nbsp;</a></span>smtc_modem_derive_keys()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="smtc__modem__api_8h.html#a952d295e178005c052f035b4099ada4a">smtc_modem_return_code_t</a> smtc_modem_derive_keys </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>stack_id</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Derive keys if applicable. </p>
<dl class="section remark"><dt>Remarks</dt><dd>This command can only be used on a Basic Modem with LR1110 radio Derives application key taking saved dev_eui (default set to chip_eui) and saved join_eui</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>Modem return code as defined in <a class="el" href="smtc__modem__api_8h.html#a952d295e178005c052f035b4099ada4a">smtc_modem_return_code_t</a> </dd></dl>

</div>
</div>
<a id="adb18f0cba3713bd58ffbe5c80a3f45d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb18f0cba3713bd58ffbe5c80a3f45d9">&#9670;&nbsp;</a></span>smtc_modem_get_chip_eui()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="smtc__modem__api_8h.html#a952d295e178005c052f035b4099ada4a">smtc_modem_return_code_t</a> smtc_modem_get_chip_eui </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>stack_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>chip_eui</em>[SMTC_MODEM_EUI_LENGTH]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the modem chip eui if applicable. </p>
<dl class="section remark"><dt>Remarks</dt><dd>This command can only be used on a Basic Modem with LR1110 radio</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">stack_id</td><td>The stack identifier </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">chip_eui*</td><td>Return the 8 bytes of the chip eui</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Modem return code as defined in <a class="el" href="smtc__modem__api_8h.html#a952d295e178005c052f035b4099ada4a">smtc_modem_return_code_t</a> </dd></dl>

</div>
</div>
<a id="a8e647ada35b4b3d754f2eb80f29f2305"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e647ada35b4b3d754f2eb80f29f2305">&#9670;&nbsp;</a></span>smtc_modem_get_pin()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="smtc__modem__api_8h.html#a952d295e178005c052f035b4099ada4a">smtc_modem_return_code_t</a> smtc_modem_get_pin </td>
          <td>(</td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>stack_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>chip_pin</em>[SMTC_MODEM_PIN_LENGTH]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the modem pin code if applicable. </p>
<dl class="section remark"><dt>Remarks</dt><dd>This command can only be used on a Basic Modem with LR1110 radio</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">stack_id</td><td>The stack identifier </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">chip_pin*</td><td>Return the 4 bytes of pin code</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Modem return code as defined in <a class="el" href="smtc__modem__api_8h.html#a952d295e178005c052f035b4099ada4a">smtc_modem_return_code_t</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
